Get History Alarm Details

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/alerts/history/{alertRecordId}
alertRecordId: String. Alarm record ID.

Response

• 200: Successful.

  [ 
    {    
      "alertRecordId": "a95eb247e47e466ebcc1e5ff8df764a1",    
      "alarmName": "uuid1079ef50a32c4b1d8dad7f97addf46fd",    
      "triggerCompareOperator": "GT",   
      "priority": 1,    
      "templateName": "materialInfo",    
      "templateNamespace": "system",    
      "instanceName": "m_100012870",    
      "attributeName": "discharge_pressure",    
      "instanceDisplayName": "obj_data2",    
      "attributeDisplayName": "pro_obj",    
      "displayName": "alarm6",    
      "ackUserName": "test",    
      "ackStatus": 0,    
      "triggerCondition": "150 > 100",    
      "description": "Trigger alarm when exceeding 100",    
      "startDatetime": "2021-04-06T16:00:00.000+08:00",    
      "ackDatetime": "2021-04-06T17:00:00.000+08:00",    
      "disappearedDatetime": "2021-04-06T18:00:00.000+08:00",    
      "triggerAttributeValue": "150",    
      "disappearedStatus": 0  
      }
      ]
• 400: General internal error of OODM.

  {
    "code": 90900006,
    "message": "invalid histroy alarm ID",
    "data": {},
    "detail": "string"
  }

Get History Record of Alarm

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/alerts/history

Query parameters

Table 1. Query parameter description

Parameter	Type	Description
keyword	string	Use the keyword to fuzzy match the name or alias of the instance and attribute under which the alarm is created, and alarm description.
ackUserName	string	User who confirms the alarm.
ackStatus	integer	Confirmation status. 0 means not confirmed and 1 means confirmed.
startTime	string (date-time)	Triggering time of the alarm. Adopts RFC 3399 standards with the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, for example 2021-04-06T16:00:00.000+08:00 (+08:00 means time zone deviation).
endTime	string (date-time)	End time of the alarm.
status	integer	Alarm record status. 0 means disappeared and 1 means it is happening.
current	integer	Current page. The default is 1.
pageSize	integer	The number of data on each page. The default is 20 and the maximum is 500.
priorities	string	Alarm priority from 1-10. Use comma to separate multiple priorities.
displayName	string	Alarm name.
orderBy	string	Sorting order. You can sort the data of each field by writing like priority desc,start_datatimestamp desc. The default is start_datatimestamp desc.

Request Body

Get running alarms with p1 in instance alias or name, attribute alias or name, or alarm description, and happen between 2021-04-01 16:00:00 to 2021-04-10 23:59:59

keyword:p1 startTime:2021-04-01T16:00:00.000+08:00 endTime:2021-04-10T23:59:59.000+08:00 status:1

Response

• 200: Successful.

  {
    "list": [
      {
        "alertRecordId": "0ccf80f0c7a842d19ef53ee6209d0d9c",
        "priority": 1,
        "displayName": "L",
        "startDatetime": "2021-04-06T08:00:00.000Z",
        "ackDatetime": "2021-04-06T09:00:00.000Z",
        "disappearedDatetime": "2021-04-06T10:00:00.000Z",
        "instanceName": "T11020225",
        "attributeName": "material_spec",
        "instanceDisplayName": "obj_data2",
        "attributeDisplayName": "specification"
      }
    ],
    "pagination": {
      "total": 10,
      "pageSize": 20,
      "current": 1
    }
  }
• 400: General internal error of OODM.

  {
    "code": 90900005,
    "message": "wrong time format",
    "data": {},
    "detail": "string"
  }